Skip to main content
Feedback

Endpoint More Settings

The Endpoint More Settings page allows you to configure the Traffic Manager-specific settings. For example, you can configure the Traffic Manager to include or exclude headers from the requests and responses.

Time to wait for a response from endpoint

This selection determines the number of seconds by which the Traffic Manager receives a response from the host server after an API call is connected. If a response is not received within this specified time, the Traffic Manager returns a 504 Gateway Timeout error.

Seconds to attempt initial connection to endpoint

This selection determines the number of seconds that the Traffic Manager takes for an API call to connect on a TCP level to the host server. If the connection fails to get established in this specified period, the Traffic Manager returns a 504 Gateway Timeout error.

Number of HTTP Redirects to follow (as needed)

This setting enables the Traffic Manager to handle redirects from the client API servers.

For example,

  • 0: Configures the Traffic Manager not to follow and to pass the redirects back to the customer. This is the default redirect setting.

  • 4: Configures the Traffic Manager to handle four redirects from the host server before issuing a redirect to the customer.

Enable Cookies during redirects

This setting determines if the cookies are enabled and collected during server requests from the Traffic Manager to the host server.

GZIP Passthrough

This setting enables the Traffic Manager to accept and send gzip-formatted directives to the host server.

Force GZip Accept-encoding on backend call

This setting enables the Traffic Manager to force the gzip directive to the host server regardless of the accept-encoding value passed by the client. This setting helps improve the round-trip speed of large API calls by reducing the latency between the Traffic Manager and the host API servers.

Remove API Key and Signature from Endpoint Call

This setting enables the Traffic Manager to remove the API key and signature from the URL query parameters before Cloud API Management sends the API call to the target backend service endpoint.

Allow calls having no API Key

This setting enables the Traffic Manager to accept API calls without keys. It requires that a special API key be created with the key value noapikey. The Traffic Manager uses this key to accept the API call, apply the business rules, and log requests for the endpoint.

Swap Incoming API credentials for API Management Credentials

This setting determines whether a developer key associated with an API call is to be swapped with another key before the Traffic Manager passes the call to the host server.

Forwarded Headers

This setting includes the following forwarded header values:

  • API Management Service ID: It is the unique identifier for the API Service being consumed.

  • API Management Host: It is the name of the host used to connect to Cloud API Management.

    For example, api.customer.com might be cnamed to customer.api.mashery.com. The incoming call could be api.customer.com/doSomething. In this case, the Cloud API Management host header value would be api.customer.com.

  • API Management Message ID: It is a unique ID generated for every API call processed by the Cloud API Management network. It configures the Traffic Manager to include this ID in the request to the host server. This ID helps debug issues and track the API events.

Returned Headers

This setting includes the following returned header values:

  • API Management Responder: It configures the Traffic Manager to include the name of the worker responding to the request via a customer returned header.

  • API Management Message ID: It is a unique ID generated for every API call processed by the Cloud API Management network. It configures the Traffic Manager to include this ID in the client's response. This ID helps debug issues and track the API events.

Pass Through Host Header in Request

This setting enables the Traffic Manager to pass through the host header used during the inbound connection through Cloud API Management. For example, if the inbound host is api.customer.com, the host header value should be api.customer.com when the call is passed through to the host server.

HTTP Headers to Drop from Incoming Call: (one per line)

This setting enables the Traffic Manager to remove HTTP headers from an API call before passing it to the client API servers.

JSONP Callback Function Parameter

This setting determines the parameter that identifies the callback function that handles the JSON response.

Default JSONP Callback Function Parameter Value

This setting allows you to set the default parameter value to effectively handle the JSON response.

Include rate limit information in response headers

This setting allows rate limit information to be included in response headers sent back to the calling application. This is useful for the developers to help them understand the current usage of the API.

The difference in the header naming convention is due to the rate limit configuration on the keys. If the rate limit at the key level is set to default, it will take the plan's rate limits, and the headers returned will have a Plan string in them. Otherwise, if the rate limit at the key level is set to Custom limit, it will take up the key's rate limit, and the headers returned will have a PackageKey string in them.

Next Steps

Configure Traffic Manager-specific settings on the Endpoint More Settings page. To learn more, refer to Configuring Endpoint More Settings.

On this Page